Message arguments for input manipulator messages. More...

#include <kanzi/core.ui/input/input_manipulator.hpp>

Inheritance diagram for kanzi::InputManipulator::InputMessageArguments:

Public Member Functions
NodeSharedPtr	getHitTestObject ()
	Gets the 3D node that is the object of hit testing.

Vector2	getHitTestPoint () const
	The position of the primary touch point in the object space of the node that generated the hit test.

Vector3	getHitTestRayDirection () const
	Hit test ray direction vector (normalized) in the local space of the hit test camera. Provided when hitting a 3D node.

float	getHitTestRayDistance () const
	Gets the hit test ray distance between the camera and the bounding box of the hit test node.

Vector3	getHitTestRayOrigin () const
	Origin of the hit test ray in the local space of the hit test camera. Provided when hitting a 3D node.

Vector2	getPoint () const
	The position of the primary touch point.

Vector3	getRayDirection () const
	Pick ray direction vector (normalized) in the local space of the enclosing Viewport node.

Vector3	getRayOrigin () const
	The origin of the pick ray in the local space of the enclosing Viewport node.

void	setHitTestObject (Node *node)
	Sets the 3D node that is the object of hit testing.

void	setHitTestPoint (Vector2 value)

void	setHitTestRayDirection (Vector3 value)

void	setHitTestRayDistance (float value)
	Sets the hit test ray distance between the camera and the bounding box of the hit test node.

void	setHitTestRayOrigin (Vector3 value)

void	setPoint (Vector2 value)

void	setRayDirection (Vector3 value)

void	setRayOrigin (Vector3 value)

Public Member Functions inherited from kanzi::MessageArguments
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
	Returns the value of an argument using AbstractPropertyType.

template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

detail::MessageDispatcher *	getDispatcher () const
	Returns the message dispatcher that dispatches a message.

template<typename TDataType >
optional< TDataType >	getOptionalArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

shared_ptr< Node >	getSource () const
	Returns the source node for a message.

TimePoint	getTimestamp () const
	Returns the timestamp of a message.

AbstractMessageType	getType () const
	Returns the message type of these message arguments as an AbstractMessageType instance.

bool	isFrom (const Node &source) const
	Returns whether a node is the source node of a message.

bool	isHandled () const
	Returns whether the message is handled.

bool	isValid () const
	Returns whether a message is valid.

	MessageArguments ()=default
	Constructor.

	MessageArguments (const MessageArguments &)=delete
	Deleted copy.

MessageArguments &	operator= (const MessageArguments &)=delete
	Deleted assignment.

void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
	Sets the value of an argument using AbstractPropertyType.

template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
	Sets the value of an argument.

void	setDispatcher (detail::MessageDispatcher *dispatcher)
	Sets a dispatcher for a message.

void	setHandled (bool handled)
	Sets the handling status for a message.

void	setSource (Node *source)
	Sets the source node that dispatches a message.

void	setTimestamp (TimePoint timestamp)
	Sets the timestamp of a message.

void	setType (AbstractMessageType type)
	Sets the type of a message.

void	setValid (bool valid)
	Sets the validity of a message.

	~MessageArguments ()
	Destructor.

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::MessageArguments
static size_t	getArgumentAllocatorPoolSize ()
	Gets the current size of memory pool of argument entries.

static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information.

Static Public Attributes
static PropertyType< void * >	HitTestObjectProperty
	Reports the 3D node that is the object of hit testing.

static PropertyType< Vector2 >	HitTestPointProperty
	HitTestPoint property.

static PropertyType< Vector3 >	HitTestRayDirectionProperty
	HitTestRayDirection property.

static PropertyType< float >	HitTestRayDistanceProperty
	Reports the distance along the hit test ray between the camera and the bounding box of a 3D hit test node.

static PropertyType< Vector3 >	HitTestRayOriginProperty
	HitTestRayOrigin property.

static PropertyType< Vector2 >	ManipulatorPointProperty
	ManipulatorPoint property.

static PropertyType< Vector3 >	ManipulatorRayDirectionProperty
	ManipulatorRayDirection property.

static PropertyType< Vector3 >	ManipulatorRayOriginProperty
	ManipulatorRayOrigin property.

Detailed Description

Message arguments for input manipulator messages.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::InputManipulator::InputMessageArguments::makeEditorInfo ( )

static

◆ getPoint()

Vector2 kanzi::InputManipulator::InputMessageArguments::getPoint ( ) const

inline

The position of the primary touch point.

When hitting a 2D node, the value is in local space of the attached node or the provided reference node (see InputManipulator::setReferenceNode) When hitting a 3D node, the value is in local space of the enclosing Viewport node.

◆ setPoint()

void kanzi::InputManipulator::InputMessageArguments::setPoint ( Vector2 value )

inline

◆ getRayOrigin()

Vector3 kanzi::InputManipulator::InputMessageArguments::getRayOrigin ( ) const

inline

The origin of the pick ray in the local space of the enclosing Viewport node.

ManipulatorRayOriginProperty is Provided when hitting a 3D node.

◆ setRayOrigin()

void kanzi::InputManipulator::InputMessageArguments::setRayOrigin ( Vector3 value )

inline

◆ getRayDirection()

Vector3 kanzi::InputManipulator::InputMessageArguments::getRayDirection ( ) const

inline

Pick ray direction vector (normalized) in the local space of the enclosing Viewport node.

ManipulatorRayDirectionProperty is provided when hitting a 3D node.

◆ setRayDirection()

void kanzi::InputManipulator::InputMessageArguments::setRayDirection ( Vector3 value )

inline

◆ getHitTestPoint()

Vector2 kanzi::InputManipulator::InputMessageArguments::getHitTestPoint ( ) const

inline

The position of the primary touch point in the object space of the node that generated the hit test.

When hitting a 2D node, the value is in screen space. When hitting a 3D node, the value is in local space of the hit test camera.

◆ setHitTestPoint()

void kanzi::InputManipulator::InputMessageArguments::setHitTestPoint ( Vector2 value )

inline

◆ getHitTestRayOrigin()

Vector3 kanzi::InputManipulator::InputMessageArguments::getHitTestRayOrigin ( ) const

inline

Origin of the hit test ray in the local space of the hit test camera. Provided when hitting a 3D node.

◆ setHitTestRayOrigin()

void kanzi::InputManipulator::InputMessageArguments::setHitTestRayOrigin ( Vector3 value )

inline

◆ getHitTestRayDirection()

Vector3 kanzi::InputManipulator::InputMessageArguments::getHitTestRayDirection ( ) const

inline

Hit test ray direction vector (normalized) in the local space of the hit test camera. Provided when hitting a 3D node.

◆ setHitTestRayDirection()

void kanzi::InputManipulator::InputMessageArguments::setHitTestRayDirection ( Vector3 value )

inline

◆ getHitTestRayDistance()

float kanzi::InputManipulator::InputMessageArguments::getHitTestRayDistance ( ) const

inline

Gets the hit test ray distance between the camera and the bounding box of the hit test node.

Provided when hitting a 3D node.

Since: Kanzi 3.9.5

◆ setHitTestRayDistance()

void kanzi::InputManipulator::InputMessageArguments::setHitTestRayDistance ( float value )

inline

Sets the hit test ray distance between the camera and the bounding box of the hit test node.

Since: Kanzi 3.9.5

◆ getHitTestObject()

NodeSharedPtr kanzi::InputManipulator::InputMessageArguments::getHitTestObject ( )

inline

Gets the 3D node that is the object of hit testing.

Since: Kanzi 3.9.5

◆ setHitTestObject()

void kanzi::InputManipulator::InputMessageArguments::setHitTestObject ( Node * node )

inline

Sets the 3D node that is the object of hit testing.

Since: Kanzi 3.9.5

Member Data Documentation

◆ ManipulatorPointProperty

PropertyType<Vector2> kanzi::InputManipulator::InputMessageArguments::ManipulatorPointProperty

static

ManipulatorPoint property.

The default value is Vector2(0.0f, 0.0f).

See also: setManipulatorPoint(), getManipulatorPoint()

◆ ManipulatorRayOriginProperty

PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::ManipulatorRayOriginProperty

static

ManipulatorRayOrigin property.

The default value is Vector3(0.0f, 0.0f, 0.0f).

See also: setManipulatorRayOrigin(), getManipulatorRayOrigin()

◆ ManipulatorRayDirectionProperty

PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::ManipulatorRayDirectionProperty

static

ManipulatorRayDirection property.

The default value is Vector3(0.0f, 0.0f, -1.0f).

See also: setManipulatorRayDirection(), getManipulatorRayDirection()

◆ HitTestPointProperty

PropertyType<Vector2> kanzi::InputManipulator::InputMessageArguments::HitTestPointProperty

static

HitTestPoint property.

The default value is Vector2::nan().

See also: setHitTestPoint(), getHitTestPoint()

◆ HitTestRayOriginProperty

PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::HitTestRayOriginProperty

static

HitTestRayOrigin property.

The default value is Vector3(0.0f, 0.0f, 0.0f).

See also: setHitTestRayOrigin(), getHitTestRayOrigin()

◆ HitTestRayDirectionProperty

PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::HitTestRayDirectionProperty

static

HitTestRayDirection property.

The default value is Vector3(0.0f, 0.0f, -1.0f).

See also: setHitTestRayDirection(), getHitTestRayDirection()

◆ HitTestRayDistanceProperty

PropertyType<float> kanzi::InputManipulator::InputMessageArguments::HitTestRayDistanceProperty

static

Reports the distance along the hit test ray between the camera and the bounding box of a 3D hit test node.

The default value is 0.0f.

Since: Kanzi 3.9.5

See also: setHitTestRayDistance(), getHitTestRayDistance()

◆ HitTestObjectProperty

PropertyType<void*> kanzi::InputManipulator::InputMessageArguments::HitTestObjectProperty

static

Reports the 3D node that is the object of hit testing.

The default value is 0.

See also: setHitTestObject(), getHitTestObject()

The documentation for this class was generated from the following file:

kanzi/core.ui/input/input_manipulator.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ makeEditorInfo()

◆ getPoint()

◆ setPoint()

◆ getRayOrigin()

◆ setRayOrigin()

◆ getRayDirection()

◆ setRayDirection()

◆ getHitTestPoint()

◆ setHitTestPoint()

◆ getHitTestRayOrigin()

◆ setHitTestRayOrigin()

◆ getHitTestRayDirection()

◆ setHitTestRayDirection()

◆ getHitTestRayDistance()

◆ setHitTestRayDistance()

◆ getHitTestObject()

◆ setHitTestObject()

Member Data Documentation

◆ ManipulatorPointProperty

◆ ManipulatorRayOriginProperty

◆ ManipulatorRayDirectionProperty

◆ HitTestPointProperty

◆ HitTestRayOriginProperty

◆ HitTestRayDirectionProperty

◆ HitTestRayDistanceProperty

◆ HitTestObjectProperty